WorkCorpus for Kotlin/fm.apakabar.workcorpus

Package-level declarations

Types

@Serializable(with = DifficultWordsConfigurationSerializer::class)

data class DifficultWordsConfiguration(val scoreThreshold: Int)

Configuration for classifying repeatedly missed words.

data class HeldPiece(val number: Int, val title: String, val lines: List<String>, val partTitle: String, val partShort: String?, val partSummary: String, val cutSizes: Map<String, List<Int>> = emptyMap())

Piece and part values already held by a caller, before assembling a Work.

data class HeldReading(val untouchedBelow: Double, val begunBelow: Double, val mostBelow: Double, val difficultWordScore: Int, val free: List<Int>)

Reading configuration already held by a caller before assembling a Work.

@Serializable

value class NarrationVoice(val rawValue: String)

Stable identifier of a narration voice used in asset names.

@Serializable(with = Part.Serializer::class)

data class Part(val title: String, val summary: String, val first: Int, val last: Int, short: String? = null)

A run of pieces a work is divided into: a group of sonnets, a chapter, an act.

@Serializable(with = PieceSerializer::class)

data class Piece(val number: Int, val title: String, val lines: List<String>, val cutSizes: Map<String, List<Int>> = emptyMap())

What a reader reads in one sitting: a sonnet, a stanza, a scene.

class PieceAsset(val stem: String)

Names the files of one work: its readings, their word times, and what a reader shares of their own attempt.

The size of text a reader must complete in one attempt.

@Serializable(with = StageFieldScaleSerializer::class)

data class StageFieldScale(val untouchedBelow: Double, val begunBelow: Double, val mostBelow: Double)

Divides a stage-completion fraction into display bands.

@Serializable(with = WorkSerializer::class)

data class Work

A reading work and the configuration used to present it.

Decodes, assembles, and validates portable reading works.